<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_60) on Sun Dec 20 21:23:30 CET 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>StatisticsUI (gephi 0.9.0 API)</title>
<meta name="date" content="2015-12-20">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="StatisticsUI (gephi 0.9.0 API)";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/StatisticsUI.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/statistics/spi/StatisticsBuilder.html" title="interface in org.gephi.statistics.spi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/statistics/spi/StatisticsUI.html" target="_top">Frames</a></li>
<li><a href="StatisticsUI.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.statistics.spi</div>
<h2 title="Interface StatisticsUI" class="title">Interface StatisticsUI</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">StatisticsUI</span></pre>
<div class="block">Statistics and Metrics UI integration information. Implement this interface
 for defining a new metric in the user interface.
 <p>
 One could define multiple <code>StatisticsUI</code> that relies on a single
 algorithm. StatisticsUIs therefore exist in the system alone, and wait for
 <code>setup()</code> method to be called to turn on with a compatible
 Statistics instance.
 <p>
 Implementors must add <b>@ServiceProvider</b> annotation to be found by the system.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Patrick J. McSweeney</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/gephi/statistics/spi/StatisticsBuilder.html" title="interface in org.gephi.statistics.spi"><code>StatisticsBuilder</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/statistics/spi/StatisticsUI.html#CATEGORY_DYNAMIC">CATEGORY_DYNAMIC</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/statistics/spi/StatisticsUI.html#CATEGORY_EDGE_OVERVIEW">CATEGORY_EDGE_OVERVIEW</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/statistics/spi/StatisticsUI.html#CATEGORY_NETWORK_OVERVIEW">CATEGORY_NETWORK_OVERVIEW</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/statistics/spi/StatisticsUI.html#CATEGORY_NODE_OVERVIEW">CATEGORY_NODE_OVERVIEW</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/statistics/spi/StatisticsUI.html#getCategory--">getCategory</a></span>()</code>
<div class="block">Returns the category of this metric.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/statistics/spi/StatisticsUI.html#getDisplayName--">getDisplayName</a></span>()</code>
<div class="block">Returns this statistics display name</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/statistics/spi/StatisticsUI.html#getPosition--">getPosition</a></span>()</code>
<div class="block">Returns a position value, around 1 and 1000, that indicates the position
 of the Statistics in the UI.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/javax/swing/JPanel.html?is-external=true" title="class or interface in javax.swing">JPanel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/statistics/spi/StatisticsUI.html#getSettingsPanel--">getSettingsPanel</a></span>()</code>
<div class="block">Returns a settings panel instance.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/statistics/spi/StatisticsUI.html#getShortDescription--">getShortDescription</a></span>()</code>
<div class="block">Returns this statistics short description</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../org/gephi/statistics/spi/Statistics.html" title="interface in org.gephi.statistics.spi">Statistics</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/statistics/spi/StatisticsUI.html#getStatisticsClass--">getStatisticsClass</a></span>()</code>
<div class="block">Returns the statistics' class this UI belongs to.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/statistics/spi/StatisticsUI.html#getValue--">getValue</a></span>()</code>
<div class="block">Returns this statistics result as a String, if exists</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/statistics/spi/StatisticsUI.html#setup-org.gephi.statistics.spi.Statistics-">setup</a></span>(<a href="../../../../org/gephi/statistics/spi/Statistics.html" title="interface in org.gephi.statistics.spi">Statistics</a>&nbsp;statistics)</code>
<div class="block">Push a statistics instance to the UI to load its settings.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/statistics/spi/StatisticsUI.html#unsetup--">unsetup</a></span>()</code>
<div class="block">Notify the settings panel has been closed and that the settings values
 can be saved to the statistics instance.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="CATEGORY_NETWORK_OVERVIEW">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CATEGORY_NETWORK_OVERVIEW</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CATEGORY_NETWORK_OVERVIEW</pre>
</li>
</ul>
<a name="CATEGORY_NODE_OVERVIEW">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CATEGORY_NODE_OVERVIEW</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CATEGORY_NODE_OVERVIEW</pre>
</li>
</ul>
<a name="CATEGORY_EDGE_OVERVIEW">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CATEGORY_EDGE_OVERVIEW</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CATEGORY_EDGE_OVERVIEW</pre>
</li>
</ul>
<a name="CATEGORY_DYNAMIC">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CATEGORY_DYNAMIC</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CATEGORY_DYNAMIC</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getSettingsPanel--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSettingsPanel</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/javax/swing/JPanel.html?is-external=true" title="class or interface in javax.swing">JPanel</a>&nbsp;getSettingsPanel()</pre>
<div class="block">Returns a settings panel instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a settings panel instance</dd>
</dl>
</li>
</ul>
<a name="setup-org.gephi.statistics.spi.Statistics-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setup</h4>
<pre>void&nbsp;setup(<a href="../../../../org/gephi/statistics/spi/Statistics.html" title="interface in org.gephi.statistics.spi">Statistics</a>&nbsp;statistics)</pre>
<div class="block">Push a statistics instance to the UI to load its settings. Note that this
 method is always called after <code>getSettingsPanel</code> and before the
 panel is displayed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>statistics</code> - the statistics instance that is linked to the UI</dd>
</dl>
</li>
</ul>
<a name="unsetup--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unsetup</h4>
<pre>void&nbsp;unsetup()</pre>
<div class="block">Notify the settings panel has been closed and that the settings values
 can be saved to the statistics instance.</div>
</li>
</ul>
<a name="getStatisticsClass--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatisticsClass</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../org/gephi/statistics/spi/Statistics.html" title="interface in org.gephi.statistics.spi">Statistics</a>&gt;&nbsp;getStatisticsClass()</pre>
<div class="block">Returns the statistics' class this UI belongs to.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the statistics' class this UI belongs to</dd>
</dl>
</li>
</ul>
<a name="getValue--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getValue()</pre>
<div class="block">Returns this statistics result as a String, if exists</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this statistics' result string</dd>
</dl>
</li>
</ul>
<a name="getDisplayName--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDisplayName</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDisplayName()</pre>
<div class="block">Returns this statistics display name</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this statistics' display name.</dd>
</dl>
</li>
</ul>
<a name="getShortDescription--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShortDescription</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getShortDescription()</pre>
<div class="block">Returns this statistics short description</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this statistics' short description.</dd>
</dl>
</li>
</ul>
<a name="getCategory--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCategory</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCategory()</pre>
<div class="block">Returns the category of this metric. Default category can be used, see
 <ul>
 <li><a href="../../../../org/gephi/statistics/spi/StatisticsUI.html#CATEGORY_NETWORK_OVERVIEW"><code>CATEGORY_NETWORK_OVERVIEW</code></a></li>
 <li><a href="../../../../org/gephi/statistics/spi/StatisticsUI.html#CATEGORY_NODE_OVERVIEW"><code>CATEGORY_NODE_OVERVIEW</code></a></li>
 <li><a href="../../../../org/gephi/statistics/spi/StatisticsUI.html#CATEGORY_EDGE_OVERVIEW"><code>CATEGORY_EDGE_OVERVIEW</code></a></li>
 <li><a href="../../../../org/gephi/statistics/spi/StatisticsUI.html#CATEGORY_DYNAMIC"><code>CATEGORY_DYNAMIC</code></a></li></ul>
 Returns a custom String for defining a new category.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this statistics' category</dd>
</dl>
</li>
</ul>
<a name="getPosition--">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPosition</h4>
<pre>int&nbsp;getPosition()</pre>
<div class="block">Returns a position value, around 1 and 1000, that indicates the position
 of the Statistics in the UI. Less means upper.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this statistics' position value</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/StatisticsUI.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/statistics/spi/StatisticsBuilder.html" title="interface in org.gephi.statistics.spi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/statistics/spi/StatisticsUI.html" target="_top">Frames</a></li>
<li><a href="StatisticsUI.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2015 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All rights reserved.</small></p>
</body>
</html>
